<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9"/>
<title>NGUI: BMFont Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">NGUI
   &#160;<span id="projectnumber">3.11.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Packages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_b_m_font.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_b_m_font-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">BMFont Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="class_b_m_font.html" title="BMFont reader. C# implementation of http://www.angelcode.com/products/bmfont/ ">BMFont</a> reader. C# implementation of <a href="http://www.angelcode.com/products/bmfont/">http://www.angelcode.com/products/bmfont/</a>  
 <a href="class_b_m_font.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4c383e4822a02271b131913a3b706fa0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_b_m_glyph.html">BMGlyph</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_m_font.html#a4c383e4822a02271b131913a3b706fa0">GetGlyph</a> (int index, bool createIfMissing)</td></tr>
<tr class="memdesc:a4c383e4822a02271b131913a3b706fa0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper function that retrieves the specified glyph, creating it if necessary.  <a href="#a4c383e4822a02271b131913a3b706fa0">More...</a><br /></td></tr>
<tr class="separator:a4c383e4822a02271b131913a3b706fa0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af227707949f9f9f66830509536a16e27"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_b_m_glyph.html">BMGlyph</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_m_font.html#af227707949f9f9f66830509536a16e27">GetGlyph</a> (int index)</td></tr>
<tr class="memdesc:af227707949f9f9f66830509536a16e27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the specified glyph, if it's present.  <a href="#af227707949f9f9f66830509536a16e27">More...</a><br /></td></tr>
<tr class="separator:af227707949f9f9f66830509536a16e27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fbcfa8bea70520da7f6c6ed7e085de1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_m_font.html#a2fbcfa8bea70520da7f6c6ed7e085de1">Clear</a> ()</td></tr>
<tr class="memdesc:a2fbcfa8bea70520da7f6c6ed7e085de1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the glyphs.  <a href="#a2fbcfa8bea70520da7f6c6ed7e085de1">More...</a><br /></td></tr>
<tr class="separator:a2fbcfa8bea70520da7f6c6ed7e085de1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c26228987e7796a371cd5d0607f276b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_m_font.html#a7c26228987e7796a371cd5d0607f276b">Trim</a> (int xMin, int yMin, int xMax, int yMax)</td></tr>
<tr class="memdesc:a7c26228987e7796a371cd5d0607f276b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Trim the glyphs, ensuring that they will never go past the specified bounds.  <a href="#a7c26228987e7796a371cd5d0607f276b">More...</a><br /></td></tr>
<tr class="separator:a7c26228987e7796a371cd5d0607f276b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a0acc8b6af6e41b819cfea4cd2be369ab"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_m_font.html#a0acc8b6af6e41b819cfea4cd2be369ab">isValid</a><code> [get]</code></td></tr>
<tr class="memdesc:a0acc8b6af6e41b819cfea4cd2be369ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the font can be used.  <a href="#a0acc8b6af6e41b819cfea4cd2be369ab">More...</a><br /></td></tr>
<tr class="separator:a0acc8b6af6e41b819cfea4cd2be369ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af790da3d41a81e09c5391fff8d80daf4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_m_font.html#af790da3d41a81e09c5391fff8d80daf4">charSize</a><code> [get, set]</code></td></tr>
<tr class="memdesc:af790da3d41a81e09c5391fff8d80daf4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of this font (for example 32 means 32 pixels).  <a href="#af790da3d41a81e09c5391fff8d80daf4">More...</a><br /></td></tr>
<tr class="separator:af790da3d41a81e09c5391fff8d80daf4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a916531ff5c076792b85d2ee8079cb763"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_m_font.html#a916531ff5c076792b85d2ee8079cb763">baseOffset</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a916531ff5c076792b85d2ee8079cb763"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base offset applied to characters.  <a href="#a916531ff5c076792b85d2ee8079cb763">More...</a><br /></td></tr>
<tr class="separator:a916531ff5c076792b85d2ee8079cb763"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93adb0ba2362a21fbb0f41dab68874f8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_m_font.html#a93adb0ba2362a21fbb0f41dab68874f8">texWidth</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a93adb0ba2362a21fbb0f41dab68874f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Original width of the texture.  <a href="#a93adb0ba2362a21fbb0f41dab68874f8">More...</a><br /></td></tr>
<tr class="separator:a93adb0ba2362a21fbb0f41dab68874f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a20d59b512b8e3c93569c4a7663fa3d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_m_font.html#a0a20d59b512b8e3c93569c4a7663fa3d">texHeight</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a0a20d59b512b8e3c93569c4a7663fa3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Original height of the texture.  <a href="#a0a20d59b512b8e3c93569c4a7663fa3d">More...</a><br /></td></tr>
<tr class="separator:a0a20d59b512b8e3c93569c4a7663fa3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96170849ecba6d5da3202fed7a0e54be"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_m_font.html#a96170849ecba6d5da3202fed7a0e54be">glyphCount</a><code> [get]</code></td></tr>
<tr class="memdesc:a96170849ecba6d5da3202fed7a0e54be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of valid glyphs.  <a href="#a96170849ecba6d5da3202fed7a0e54be">More...</a><br /></td></tr>
<tr class="separator:a96170849ecba6d5da3202fed7a0e54be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf0aaf0546e778fdaff709b76ba35ff6"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_m_font.html#adf0aaf0546e778fdaff709b76ba35ff6">spriteName</a><code> [get, set]</code></td></tr>
<tr class="memdesc:adf0aaf0546e778fdaff709b76ba35ff6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Original name of the sprite that the font is expecting to find (usually the name of the texture).  <a href="#adf0aaf0546e778fdaff709b76ba35ff6">More...</a><br /></td></tr>
<tr class="separator:adf0aaf0546e778fdaff709b76ba35ff6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add0cdf3bea04e97ef2c2f90e49fd6d80"><td class="memItemLeft" align="right" valign="top">List&lt; <a class="el" href="class_b_m_glyph.html">BMGlyph</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_m_font.html#add0cdf3bea04e97ef2c2f90e49fd6d80">glyphs</a><code> [get]</code></td></tr>
<tr class="memdesc:add0cdf3bea04e97ef2c2f90e49fd6d80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access to <a class="el" href="class_b_m_font.html" title="BMFont reader. C# implementation of http://www.angelcode.com/products/bmfont/ ">BMFont</a>'s entire set of glyphs.  <a href="#add0cdf3bea04e97ef2c2f90e49fd6d80">More...</a><br /></td></tr>
<tr class="separator:add0cdf3bea04e97ef2c2f90e49fd6d80"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="class_b_m_font.html" title="BMFont reader. C# implementation of http://www.angelcode.com/products/bmfont/ ">BMFont</a> reader. C# implementation of <a href="http://www.angelcode.com/products/bmfont/">http://www.angelcode.com/products/bmfont/</a> </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a2fbcfa8bea70520da7f6c6ed7e085de1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void BMFont.Clear </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Clear the glyphs. </p>

</div>
</div>
<a class="anchor" id="a4c383e4822a02271b131913a3b706fa0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_b_m_glyph.html">BMGlyph</a> BMFont.GetGlyph </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>index</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>createIfMissing</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Helper function that retrieves the specified glyph, creating it if necessary. </p>

</div>
</div>
<a class="anchor" id="af227707949f9f9f66830509536a16e27"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_b_m_glyph.html">BMGlyph</a> BMFont.GetGlyph </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>index</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieve the specified glyph, if it's present. </p>

</div>
</div>
<a class="anchor" id="a7c26228987e7796a371cd5d0607f276b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void BMFont.Trim </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>xMin</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>yMin</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>xMax</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>yMax</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Trim the glyphs, ensuring that they will never go past the specified bounds. </p>

</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a916531ff5c076792b85d2ee8079cb763"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int BMFont.baseOffset</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Base offset applied to characters. </p>

</div>
</div>
<a class="anchor" id="af790da3d41a81e09c5391fff8d80daf4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int BMFont.charSize</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Size of this font (for example 32 means 32 pixels). </p>

</div>
</div>
<a class="anchor" id="a96170849ecba6d5da3202fed7a0e54be"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int BMFont.glyphCount</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Number of valid glyphs. </p>

</div>
</div>
<a class="anchor" id="add0cdf3bea04e97ef2c2f90e49fd6d80"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">List&lt;<a class="el" href="class_b_m_glyph.html">BMGlyph</a>&gt; BMFont.glyphs</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Access to <a class="el" href="class_b_m_font.html" title="BMFont reader. C# implementation of http://www.angelcode.com/products/bmfont/ ">BMFont</a>'s entire set of glyphs. </p>

</div>
</div>
<a class="anchor" id="a0acc8b6af6e41b819cfea4cd2be369ab"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool BMFont.isValid</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Whether the font can be used. </p>

</div>
</div>
<a class="anchor" id="adf0aaf0546e778fdaff709b76ba35ff6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">string BMFont.spriteName</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Original name of the sprite that the font is expecting to find (usually the name of the texture). </p>

</div>
</div>
<a class="anchor" id="a0a20d59b512b8e3c93569c4a7663fa3d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int BMFont.texHeight</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Original height of the texture. </p>

</div>
</div>
<a class="anchor" id="a93adb0ba2362a21fbb0f41dab68874f8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int BMFont.texWidth</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Original width of the texture. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>D:/WorkDir/Unity3D_Work/taidou_arpg/Assets/NGUI/Scripts/Internal/BMFont.cs</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_b_m_font.html">BMFont</a></li>
    <li class="footer">Generated on Sat Jan 4 2020 22:30:27 for NGUI by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9 </li>
  </ul>
</div>
</body>
</html>
